@opencxh/domain 1.293.0 → 1.294.0

package/dist/entities/bookkeeping/receipt.d.ts

@@ -86,10 +86,41 @@ export interface ReceiptLine {
     /** The account in the target books (`LedgerOption.key`). */
     accountKey?: string;
     aiSuggested?: boolean;
+    /** Absent = a cost. Own books only: the line becomes a fixed asset or is spread over months. */
+    treatment?: ReceiptLineTreatment;
 }
+/**
+ * What a line becomes besides its booking (plan 041 §4): a fixed asset in a group (its account
+ * is then the group's cost account), or a prepaid cost released over months (its account is
+ * prepaid costs). Made once, when the receipt is handed to the books.
+ */
+export type ReceiptLineTreatment = {
+    kind: "asset";
+    groupId: string;
+    name?: string;
+    identifier?: string;
+    assignedUserId?: string;
+    quantity?: number;
+    aiSuggested?: boolean;
+} | {
+    kind: "spread";
+    months: number;
+    /** The first month released, as its first day. */
+    firstMonth: string;
+    resultAccountId: string;
+};
+/**
+ * Proposes "activate" for a line at or above the threshold whose account is a group's cost
+ * account: the reader picked a fixed-asset account, the amount says it is one. Never overrides
+ * what a person chose; without a threshold (no rule for the country) it proposes nothing.
+ */
+export declare function suggestTreatments(lines: readonly ReceiptLine[], groups: readonly {
+    id: string;
+    costAccountId: string;
+}[], thresholdCents: number | undefined): ReceiptLine[];
 /** Totals from the lines: the lines are the truth, the totals follow. */
 export declare function receiptTotals(lines: readonly ReceiptLine[]): Receipt["totals"];
-export type ReceiptProblem = "no_supplier" | "no_date" | "no_lines" | "no_account";
+export type ReceiptProblem = "no_supplier" | "no_date" | "no_lines" | "no_account" | "asset_without_group" | "spread_without_months";
 export declare const RECEIPT_SCOPE_KIND = "receipt";
 /** The act a sign-off on a receipt is about. */
 export declare const RECEIPT_BOOK_ACT = "book";

package/dist/entities/financing/schedule.d.ts

@@ -52,10 +52,31 @@ type PlannedPosting = Omit<ScheduledPosting, "id" | "organizationId" | "business
 export declare function monthEnd(day: string): string;
 /** `totalCents` over `months` equal parts; the last takes the rounding, so the parts add up exactly. */
 export declare function spread(totalCents: Cents, months: number): Cents[];
-/** Straight-line depreciation: (cost − residual) over the life, from the month of acquisition. */
+/**
+ * The monthly amounts, from the acquisition (or the restart after a revision) on. Linear spreads
+ * (start − residual) over the months left; declining takes the monthly share of a yearly
+ * percentage of the book value until the residual is reached, the last month exactly; none is
+ * nothing. The sum is always start − residual, never below the residual.
+ */
+export declare function depreciationParts(t: FixedAssetTerms): Cents[];
+/** Depreciation per month by the asset's method; a disposed asset plans nothing more. */
 export declare function depreciationPostings(item: Pick<FinancingItem, "id" | "name"> & {
     terms: FixedAssetTerms;
 }, through: string): PlannedPosting[];
+/**
+ * The memorial entry that takes an asset off the books: its cost and accumulated depreciation
+ * off (both on the item, so it ends at nil), the proceeds on the clearing account the sales
+ * invoice books against, and the difference on the group's disposal account.
+ */
+export declare function disposalLines(item: Pick<FinancingItem, "id" | "name" | "ledgerAccountId"> & {
+    terms: FixedAssetTerms;
+}, input: {
+    /** The item's booked movements: its accumulated depreciation, negative. */
+    movementsCents: Cents;
+    proceedsCents: Cents;
+    clearingAccountId: string;
+    disposalAccountId: string;
+}): PlannedPosting["lines"];
 /** A transitorium released month by month onto its result account. */
 export declare function accrualPostings(item: Pick<FinancingItem, "id" | "name" | "ledgerAccountId"> & {
     terms: AccrualTerms;
@@ -70,4 +91,22 @@ export declare function startingCents(terms: FixedAssetTerms | AccrualTerms): Ce
  * show it as a short-term liability (aflossingsverplichting), the rest as long-term.
  */
 export declare function shortTermPrincipal(terms: Pick<LoanTerms, "principalCents" | "ratePercent" | "method" | "termMonths" | "firstDueOn">, yearEnd: string): Cents;
+/**
+ * Part of a batch leaving: its share (quantity / the batch) of cost and accumulated depreciation
+ * comes off. The accumulated share leaves the item's sub-account; the cost share leaves the cost
+ * account without it, because the item's cost is its terms — they shrink by the same share.
+ */
+export declare function partialDisposalLines(item: Pick<FinancingItem, "id" | "name" | "ledgerAccountId"> & {
+    terms: FixedAssetTerms;
+}, input: {
+    quantity: number;
+    movementsCents: Cents;
+    proceedsCents: Cents;
+    clearingAccountId: string;
+    disposalAccountId: string;
+}): {
+    lines: PlannedPosting["lines"];
+    costCents: Cents;
+    residualCents: Cents;
+};
 export {};

package/dist/entities/financing/types.d.ts

@@ -50,10 +50,12 @@ export interface DepositTerms {
     kind: "deposit_paid";
     refundableOn?: string;
 }
+/** Straight-line over the life, a yearly percentage of the book value, or none (land). */
+export type DepreciationMethod = "linear" | "declining" | "none";
 /**
- * A fixed asset, depreciated straight-line per month from the month it was acquired. The item
- * sits under the cost account; depreciation lands on the accumulated-depreciation account, so the
- * annual accounts show cost and accumulated apart. Acquisition itself is booked by its invoice.
+ * A fixed asset, depreciated per month from the month it was acquired. The item sits under the
+ * cost account; depreciation lands on the accumulated-depreciation account, so the annual accounts
+ * show cost and accumulated apart. Acquisition itself is booked by its invoice.
  */
 export interface FixedAssetTerms {
     kind: "fixed_asset";
@@ -61,11 +63,95 @@ export interface FixedAssetTerms {
     costCents: Cents;
     residualCents: Cents;
     lifeMonths: number;
+    /** Absent on assets made before methods existed: linear. */
+    method?: DepreciationMethod;
+    /** `declining`: the yearly percentage of the book value, as a decimal string (`"25"`). */
+    ratePercent?: string;
     /** Expense: `Afschrijving inventaris`. */
     depreciationAccountId: string;
     /** Contra-asset: `Afschrijving inventaris` under the fixed assets. */
     accumulatedAccountId: string;
+    /** Register: the group it came from, what identifies it, where it is and who uses it. */
+    groupId?: string;
+    /** A licence plate, a serial number, an address. */
+    identifier?: string;
+    location?: string;
+    assignedUserId?: string;
+    /** A batch (12 laptops) is one asset with a quantity. */
+    quantity?: number;
+    /**
+     * A revision (new life, residual or method) from a month on: the schedule starts over from the
+     * book value then, numbered on from `fromSequence`, so the terms already posted stay as they are.
+     */
+    restart?: {
+        fromMonth: string;
+        bookValueCents: Cents;
+        fromSequence: number;
+    };
+    /**
+     * Part of a batch that left (3 of 12 laptops): each took its share of cost, residual and
+     * accumulated depreciation off; `costCents`, `residualCents` and `quantity` are what is left.
+     */
+    partialDisposals?: {
+        on: string;
+        quantity: number;
+        reason: "sold" | "scrapped" | "lost";
+        costCents: Cents;
+        proceedsCents: Cents;
+        buyerCompanyId?: string;
+        entryId?: string;
+    }[];
+    /** Sold, scrapped or lost: booked once, and the schedule stops. */
+    disposal?: {
+        on: string;
+        reason: "sold" | "scrapped" | "lost";
+        proceedsCents: Cents;
+        buyerCompanyId?: string;
+        entryId?: string;
+    };
+}
+/**
+ * A kind of fixed asset (plan 041 §2): a flat list per administration, no tree. A new asset takes
+ * its accounts, method and life from the group; an asset may differ from it.
+ */
+export interface AssetGroup {
+    id: string;
+    organizationId: string;
+    businessEntityId: string;
+    name: string;
+    costAccountId: string;
+    /** Absent for a group that is not depreciated (land). */
+    accumulatedAccountId?: string;
+    depreciationAccountId?: string;
+    /** Where a disposal's gain or loss lands: `Boekresultaat vervoermiddelen`. */
+    disposalAccountId: string;
+    method: DepreciationMethod;
+    lifeMonths?: number;
+    ratePercent?: string;
+    residualPercent?: string;
+    archived?: boolean;
+    createdAt?: number;
+    updatedAt?: number;
 }
+/**
+ * Below this a purchase is a cost, at or above it a fixed asset: per country, an administration
+ * may set its own. Only the Netherlands is filled in (€ 450, the fiscal rule); a country comes
+ * with its country pack. Known, not built: DE € 800 (GWG), FR € 500 HT, US $ 2,500 (de minimis).
+ * BE and UK have no statutory threshold: their own valuation rules decide.
+ */
+export declare const CAPITALIZATION_THRESHOLD_CENTS: Readonly<Record<string, Cents>>;
+export declare const capitalizationThreshold: (country?: string, own?: Cents) => Cents | undefined;
+/** The groups a new administration starts with, by template account code. */
+export declare const ASSET_GROUP_SEEDS: readonly {
+    name: string;
+    cost: string;
+    accumulated?: string;
+    depreciation?: string;
+    disposal: string;
+    method: DepreciationMethod;
+    lifeMonths?: number;
+    residualPercent?: string;
+}[];
 /**
  * An amount spread over months (transitoria): prepaid insurance released to costs, revenue
  * invoiced ahead released to revenue, costs accrued before their invoice. `expense` debits the
@@ -101,6 +187,8 @@ export interface FinancingItem {
     openedOn?: string;
     closedOn?: string;
     archived?: boolean;
+    /** Made from a document line (`receipt:<id>:<line>`): once per line. */
+    sourceKey?: string;
     createdAt?: number;
     updatedAt?: number;
 }

package/dist/entities/ledger/template.d.ts

@@ -33,3 +33,8 @@ export interface LedgerTemplate {
  */
 export declare const NL_BV_TEMPLATE: LedgerTemplate;
 export declare const LEDGER_TEMPLATES: readonly LedgerTemplate[];
+/**
+ * The categories a payroll journal books on (HRM, or a package like Nmbrs or Loket), and the
+ * template account each lands on unless a posting rule says otherwise.
+ */
+export declare const PAYROLL_CATEGORIES: Readonly<Record<string, string>>;

package/dist/entities/ledger/types.d.ts

@@ -19,6 +19,11 @@ export interface LedgerAccount {
     };
     /** Accounts with detail (bank, loan, current account) require a `subAccountId` on every line. */
     requiresSubAccount?: boolean;
+    /**
+     * The VAT code a line on this account usually carries (`TaxCode.key`, e.g. `high`): proposed
+     * when a bank line is booked straight onto it. Empty is none.
+     */
+    defaultTaxCode?: string;
     /** Where it sits in the reports: `"revenue.net"`, `"costs.office"`. The reports are not hard-coded. */
     reportGroup?: string;
     order?: number;
@@ -155,7 +160,7 @@ export interface PostingRule {
     organizationId: string;
     businessEntityId: string;
     appliesTo: {
-        direction: "sale" | "purchase";
+        direction: BookingDocument["direction"];
         kind?: BookingDocument["kind"];
     };
     match: {

package/dist/entities/reports/reports.d.ts

@@ -29,6 +29,15 @@ export interface BooksReport {
     /** Where the figures come from: our books, or a connected package by name. */
     source: string;
 }
+/** A report row with its amount in this period and in the one it is compared to. */
+export interface ComparedRow extends BooksReportRow {
+    priorCents: Cents;
+}
+/**
+ * Two reports of the same kind side by side. A row only one of them has (an account that moved
+ * last year and not this year) keeps its place under its own parent, with 0 on the other side.
+ */
+export declare function compareReports(current: BooksReport, prior: BooksReport | null): ComparedRow[];
 /** A posted line as the reports need it: account, day, signed amount (debit +). */
 export interface ReportLine {
     accountId: string;

package/dist/entities/work/index.d.ts

@@ -3,6 +3,6 @@ export * from './attention';
 export * from './item-types';
 export * from './keys';
 export * from './ladder';
+export * from './recurrence';
 export * from './types';
 export * from './view';
-export * from './recurrence';

package/dist/entities/work/types.d.ts

@@ -1,6 +1,6 @@
-import { WorkRecurrence } from './recurrence';
 import { Relation } from '../../platform/resource-source';
 import { OwnerScope } from '../scope/types';
+import { WorkRecurrence } from './recurrence';
 /**
  * Work management — one entity for everything that is *work*.
  *